Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add sdk reference docs #257

Merged
merged 2 commits into from
Jul 19, 2024
Merged

add sdk reference docs #257

merged 2 commits into from
Jul 19, 2024

Conversation

karthik2804
Copy link
Collaborator

@karthik2804 karthik2804 commented Jul 18, 2024 •
edited
Loading

Adds doc comments to the SDK and generates the SDK reference.

Todo:

  • Document the exceptions thrown when calling the spin host APIs
  • Write a script to copy over old SDK docs into the docs folder so that both can be hosted.

@karthik2804 karthik2804 force-pushed the add_sdk_docs branch 2 times, most recently from 8fc4fe8 to a42cbb4 Compare July 18, 2024 17:44
@karthik2804
add sdk reference docs
d9ac387 
Signed-off-by: karthik2804 <karthik.ganeshram@fermyon.com>
@karthik2804
add docs to exclude list in tsconfig
70cf782 
Signed-off-by: karthik2804 <karthik.ganeshram@fermyon.com>
@karthik2804 karthik2804 marked this pull request as ready for review July 19, 2024 13:38
@karthik2804 karthik2804 merged commit 65bd3cc into fermyon:feat/sdk-v2 Jul 19, 2024
2 checks passed
@karthik2804 karthik2804 deleted the add_sdk_docs branch July 19, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@radu-matei radu-matei Awaiting requested review from radu-matei

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@karthik2804